<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bluetooth LE Mesh Library: Mesh Client Library API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Bluetooth LE Mesh Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__wiced__bt__mesh__client.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Mesh Client Library API<div class="ingroups"><a class="el" href="group__wiced__bt__mesh.html">LE Mesh</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>The mesh client API. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga987b4bd4b29e503dbc9fd7da3d66da25"><td class="memItemLeft" align="right" valign="top">wiced_bool_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wiced__bt__mesh__client.html#ga987b4bd4b29e503dbc9fd7da3d66da25">wiced_bt_mesh_remote_provisioning_is_gatt_connecting</a> (void)</td></tr>
<tr class="memdesc:ga987b4bd4b29e503dbc9fd7da3d66da25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checking GATT connection.  <a href="#ga987b4bd4b29e503dbc9fd7da3d66da25">More...</a><br /></td></tr>
<tr class="separator:ga987b4bd4b29e503dbc9fd7da3d66da25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6846d2264854032cc1be924f6e5a9f19"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wiced__bt__mesh__client.html#ga6846d2264854032cc1be924f6e5a9f19">wiced_bt_mesh_remote_provisioning_connection_state_changed</a> (uint16_t conn_id, uint16_t reason)</td></tr>
<tr class="memdesc:ga6846d2264854032cc1be924f6e5a9f19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connection State Changed.  <a href="#ga6846d2264854032cc1be924f6e5a9f19">More...</a><br /></td></tr>
<tr class="separator:ga6846d2264854032cc1be924f6e5a9f19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c70ecd8be9dd7681a7ee00191f49cbf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wiced__bt__mesh__client.html#ga9c70ecd8be9dd7681a7ee00191f49cbf">wiced_bt_mesh_client_search_proxy</a> (uint8_t start)</td></tr>
<tr class="memdesc:ga9c70ecd8be9dd7681a7ee00191f49cbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Search for Proxy device.  <a href="#ga9c70ecd8be9dd7681a7ee00191f49cbf">More...</a><br /></td></tr>
<tr class="separator:ga9c70ecd8be9dd7681a7ee00191f49cbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1b9f2c0b16806208c1434cbd19ae094d"><td class="memItemLeft" align="right" valign="top">wiced_bool_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wiced__bt__mesh__client.html#ga1b9f2c0b16806208c1434cbd19ae094d">wiced_bt_mesh_client_proxy_connect</a> (<a class="el" href="structwiced__bt__mesh__proxy__connect__data__t.html">wiced_bt_mesh_proxy_connect_data_t</a> *p_data)</td></tr>
<tr class="memdesc:ga1b9f2c0b16806208c1434cbd19ae094d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Proxy Connect.  <a href="#ga1b9f2c0b16806208c1434cbd19ae094d">More...</a><br /></td></tr>
<tr class="separator:ga1b9f2c0b16806208c1434cbd19ae094d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga498c876da4517a9ad622c9d6b400b85f"><td class="memItemLeft" align="right" valign="top">wiced_bool_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wiced__bt__mesh__client.html#ga498c876da4517a9ad622c9d6b400b85f">wiced_bt_mesh_client_proxy_disconnect</a> (void)</td></tr>
<tr class="memdesc:ga498c876da4517a9ad622c9d6b400b85f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Proxy Disonnect.  <a href="#ga498c876da4517a9ad622c9d6b400b85f">More...</a><br /></td></tr>
<tr class="separator:ga498c876da4517a9ad622c9d6b400b85f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga149dd367c0e623c9cb6127506059c00c"><td class="memItemLeft" align="right" valign="top"><a id="ga149dd367c0e623c9cb6127506059c00c"></a>
wiced_bool_t&#160;</td><td class="memItemRight" valign="bottom"><b>wiced_bt_mesh_client_provision_connect</b> (<a class="el" href="structwiced__bt__mesh__event__t.html">wiced_bt_mesh_event_t</a> *p_event, <a class="el" href="structwiced__bt__mesh__provision__connect__data__t.html">wiced_bt_mesh_provision_connect_data_t</a> *p_connect, wiced_bool_t use_pb_gatt)</td></tr>
<tr class="separator:ga149dd367c0e623c9cb6127506059c00c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga06c7244e2e167ae29995e8ff6da58c36"><td class="memItemLeft" align="right" valign="top">wiced_bool_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wiced__bt__mesh__client.html#ga06c7244e2e167ae29995e8ff6da58c36">wiced_bt_mesh_provision_disconnect</a> (<a class="el" href="structwiced__bt__mesh__event__t.html">wiced_bt_mesh_event_t</a> *p_event)</td></tr>
<tr class="memdesc:ga06c7244e2e167ae29995e8ff6da58c36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provisioner Disconnect.  <a href="#ga06c7244e2e167ae29995e8ff6da58c36">More...</a><br /></td></tr>
<tr class="separator:ga06c7244e2e167ae29995e8ff6da58c36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc49027b1a5076322f9924133dcfa2c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wiced__bt__mesh__client.html#gabc49027b1a5076322f9924133dcfa2c4">wiced_bt_ble_set_scan_mode</a> (uint8_t is_active)</td></tr>
<tr class="memdesc:gabc49027b1a5076322f9924133dcfa2c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Scan Mode.  <a href="#gabc49027b1a5076322f9924133dcfa2c4">More...</a><br /></td></tr>
<tr class="separator:gabc49027b1a5076322f9924133dcfa2c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29b4dab0957dabe3478ad3aa7c207e60"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wiced__bt__mesh__client.html#ga29b4dab0957dabe3478ad3aa7c207e60">wiced_bt_mesh_client_vendor_data</a> (<a class="el" href="structwiced__bt__mesh__event__t.html">wiced_bt_mesh_event_t</a> *p_event, uint8_t *p_data, uint16_t data_len)</td></tr>
<tr class="memdesc:ga29b4dab0957dabe3478ad3aa7c207e60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Vendor Data message.  <a href="#ga29b4dab0957dabe3478ad3aa7c207e60">More...</a><br /></td></tr>
<tr class="separator:ga29b4dab0957dabe3478ad3aa7c207e60"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga987b4bd4b29e503dbc9fd7da3d66da25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga987b4bd4b29e503dbc9fd7da3d66da25">&#9670;&nbsp;</a></span>wiced_bt_mesh_remote_provisioning_is_gatt_connecting()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wiced_bool_t wiced_bt_mesh_remote_provisioning_is_gatt_connecting </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Checking GATT connection. </p>
<p>This function returns TRUE if remote provisioning started GATT connection</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">none</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WICED_TRUE/WICED_FALSE - success/failed. </dd></dl>

</div>
</div>
<a id="ga6846d2264854032cc1be924f6e5a9f19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6846d2264854032cc1be924f6e5a9f19">&#9670;&nbsp;</a></span>wiced_bt_mesh_remote_provisioning_connection_state_changed()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wiced_bt_mesh_remote_provisioning_connection_state_changed </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>conn_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>reason</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Connection State Changed. </p>
<p>The application shall call this function when connection is established or dropped.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">conn_id</td><td>GATT connection ID, or 0 if connection is lost. </td></tr>
    <tr><td class="paramname">reason</td><td>Disconnection reason</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WICED_TRUE/WICED_FALSE - success/failed. </dd></dl>

</div>
</div>
<a id="ga9c70ecd8be9dd7681a7ee00191f49cbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9c70ecd8be9dd7681a7ee00191f49cbf">&#9670;&nbsp;</a></span>wiced_bt_mesh_client_search_proxy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wiced_bt_mesh_client_search_proxy </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>start</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Search for Proxy device. </p>
<p>Process command from the MCU to start or stop scanning for GATT Proxy devices.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">p_data</td><td>Pointer to the data structure with start/stop information.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WICED_TRUE/WICED_FALSE - success/failed. </dd></dl>

</div>
</div>
<a id="ga1b9f2c0b16806208c1434cbd19ae094d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1b9f2c0b16806208c1434cbd19ae094d">&#9670;&nbsp;</a></span>wiced_bt_mesh_client_proxy_connect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wiced_bool_t wiced_bt_mesh_client_proxy_connect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structwiced__bt__mesh__proxy__connect__data__t.html">wiced_bt_mesh_proxy_connect_data_t</a> *&#160;</td>
          <td class="paramname"><em>p_data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Proxy Connect. </p>
<p>The application can call this function to establish GATT Proxy connection. Depending on the parameters the connection should be establishing either to a device advertising it's identity, or a device advertising a mesh network</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">p_data</td><td>Pointer to the data structure with the node identity or network.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WICED_TRUE/WICED_FALSE - success/failed. </dd></dl>

</div>
</div>
<a id="ga498c876da4517a9ad622c9d6b400b85f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga498c876da4517a9ad622c9d6b400b85f">&#9670;&nbsp;</a></span>wiced_bt_mesh_client_proxy_disconnect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wiced_bool_t wiced_bt_mesh_client_proxy_disconnect </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Proxy Disonnect. </p>
<p>The application can call this function to terminat GATT Proxy connection.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">none</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WICED_TRUE/WICED_FALSE - success/failed. </dd></dl>

</div>
</div>
<a id="ga06c7244e2e167ae29995e8ff6da58c36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga06c7244e2e167ae29995e8ff6da58c36">&#9670;&nbsp;</a></span>wiced_bt_mesh_provision_disconnect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wiced_bool_t wiced_bt_mesh_provision_disconnect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structwiced__bt__mesh__event__t.html">wiced_bt_mesh_event_t</a> *&#160;</td>
          <td class="paramname"><em>p_event</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Provisioner Disconnect. </p>
<p>The application can call this function to terminate GATT Provisioning connection.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">p_event</td><td>Pointer to the event structure which identified the remote provisioning server.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WICED_TRUE/WICED_FALSE - success/failed. </dd></dl>

</div>
</div>
<a id="gabc49027b1a5076322f9924133dcfa2c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabc49027b1a5076322f9924133dcfa2c4">&#9670;&nbsp;</a></span>wiced_bt_ble_set_scan_mode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wiced_bt_ble_set_scan_mode </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>is_active</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set Scan Mode. </p>
<p>The application can call this function to switch between passive and active scan.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">is_active</td><td>If set to 1, the stack will perform the active scan</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

</div>
</div>
<a id="ga29b4dab0957dabe3478ad3aa7c207e60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga29b4dab0957dabe3478ad3aa7c207e60">&#9670;&nbsp;</a></span>wiced_bt_mesh_client_vendor_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wiced_bt_mesh_client_vendor_data </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structwiced__bt__mesh__event__t.html">wiced_bt_mesh_event_t</a> *&#160;</td>
          <td class="paramname"><em>p_event</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>p_data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>data_len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Send Vendor Data message. </p>
<p>The application can call this function to send Vendor Data message to the Client</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">p_event</td><td>Pointer to the event structure which identified the remote provisioning server. </td></tr>
    <tr><td class="paramname">p_data</td><td>Pointer to the vendor data </td></tr>
    <tr><td class="paramname">data_len</td><td>Length of the vendor data</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Bluetooth LE Mesh Library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
